Structured Headings
Domain Message Specification

Version: 1.0; Status: RC3

Admission Tabular View

COCD_TP146062GB01
AdmissionProcedure

This template class constrains the CDA Procedure entry class.

This class is the administrative procedure of Admission.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="PROC" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a procedure.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PROC".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a procedure event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="305056002" }

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe this class as an admission procedure.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "305056002"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code. It is recommended that the preferred term is used to populate this attribute.

The value attribute of the reference element within the originalText element may be used to link the coded information to the relevant text in the CDA section.

[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time when the admission took place.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time of the admission using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the instance of the admission procedure.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] statusCode (CS { CNE:ActStatus } )
{ Fixed="completed" }

Model Attribute Description

The HL7 attribute code uses a code to describe the status of the admission procedure.

Implementation in XML Instance

The Coded Simple (CS) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain a fixed value of "completed".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#AdmissionProcedure" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#AdmissionProcedure".
[0..1] author

This template class constrains the CDA author class.

The author of the admission procedure information must be included if the author is different to the document (inherited) author.

If there is no known author for the information held on the source system then:

  • The information may be included and the document author will be deemed to be the author (by inheritance). The author should be asked to decide whether this is acceptable or not.
  • If the document author does not want to be considered as the author of the information then information must not be included in the document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as an author participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent act are conducted across to the child act (also associated with the child act). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd in the actRelationships is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP"
[1..1] [M] contentId (II) { "NPFIT-300001#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at run time with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } )
{ Fixed="OA" }

Model Attribute Description

The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author

Implementation in XML Instance

The Coded Plain data type flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element functionCode as follows:

  • The XML attribute code is fixed to "OA"
  • The XML attribute codeSystem is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.17.178"
  • The XML attribute displayName is fixed to the author's function name "Originating Author".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#author" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#author".
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time the author originally recorded the admission procedure.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Where no time is recorded or available then:

  • The XML attribute nullFlavor of the XML element time shall contain the value "UNK"
[1..1] participant (AuthorChoice)

A link to the choice of authors.
[0..1] entryRelationship

This template class constrains the CDA entryRelationship class.

This class is a component class used to link the admission procedure to an observation about the method of admission.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#entryRelationship" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#entryRelationship".
[1..1] methodOfAdmission (MethodOfAdmission)

A link to the method of admission observation.
[0..*] entryRelationship1

This template class constrains the CDA entryRelationship entry class.

This class is a component class used to link the admission procedure to coded information which is the reason(s) for admission.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#entryRelationship1" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#entryRelationship1".
[1..1] reasonForAdmission (ReasonForAdmission)

A link to the reason for admission.
[0..1] entryRelationship2

This template class constrains the CDA entryRelationship class.

This class is a component class used to link the admission procedure to an observation about the source of the patient prior to admission.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent act is conducted across to the child act (also associated with the child act).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#entryRelationship2" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#entryRelationship2".
[1..1] sourceOfPatient (SourceOfPatient)

A link to the source of patient prior to admission observation.
SourceOfPatient

This template class constrains the CDA Observation entry class.

This class is an observation about the source of the patient prior to admission.
Used by: AdmissionProcedure
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="SOP" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this as the source of the patient prior to admission.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value of "SOP"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#sourceOfPatient" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#sourceOfPatient".
[1..1] [M] value (CV { CNE:SourceOfAdmission } )

Model Attribute Description

The HL7 attribute code uses a code from the SourceOfAdmission vocabulary to describe where the patient was immediately prior to admission, e.g. place of residence, temporary place of residence, penal establishment etc...

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:


  • The XML attribute xsi:type shall contain the value "CV"
  • The XML attribute code shall a value from the SourceOfAdmission vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.509".
  • The XML attribute displayName shall carry the description associated with the code.
AuthorChoice

Refers to the choice of authors of the admission procedure.
Used by: AdmissionProcedure
[1..1] : Template

A link to the choice of author templates.
MethodOfAdmission

This template class constrains the CDA Observation entry class.

This class is an observation about the method of admission.
Used by: AdmissionProcedure
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="MOA" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a method of admission.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "MOA"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#methodOfAdmission" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#methodOfAdmission".
[1..1] [M] value (CV { CNE:AdmissionMethod } )

Model Attribute Description

The HL7 attribute code uses a code from the AdmissionMethod vocabulary to describe the method of admission.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:


  • The XML attribute xsi:type shall contain the value "CV"
  • The XML attribute code shall contain a value from the AdmissionMethod vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.16.51"
  • The XML attribute displayName shall carry the description associated with the code.
ReasonForAdmission

This template class constrains the CDA Observation entry class.

This class is an observation about the reason for admission.
Used by: AdmissionProcedure
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:CDAObservationType } )
{ Fixed="RFA" }

Model Attribute Description

The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe this class as a reason for admission.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "RFA"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.220"
  • The XML attribute displayName shall carry the description associated with the code.
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify the instance of the reason for admission.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146062GB01#reasonForAdmission" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146062GB01#reasonForAdmission".
[1..1] [M] value (CV { CNE:ReasonForAdmissionSnCT } )

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe the reason for admission.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:


  • The XML attribute xsi:type shall contain the value "CV"
  • The XML attribute code shall contain a code from the ReasonForAdmissionSnCT vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code. It is recommended that the preferred term is used to populate this attribute.